<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />

	<title>Class terrain | PhpProject1</title>

	<script type="text/javascript" src="resources/combined.js?2802348487"></script>
	<script type="text/javascript" src="elementlist.js?1053356144"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
		</div>



		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-deposits.html">deposits</a></li>
				<li><a href="class-planets.html">planets</a></li>
				<li class="active"><a href="class-terrain.html">terrain</a></li>
			</ul>





		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class terrain</h1>


	<div class="description">
	
<p>Description of terrain</p>

	</div>









	<div class="info">
		
		
		
		

				<b>Author:</b>
				Charles<br />
		<b>Located at</b> <a href="source-class-terrain.html#8-106" title="Go to source code">library/terrain.php</a><br />
	</div>



	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="getTerrainType" id="_getTerrainType">

		<td class="attributes"><code>
			 public 
			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getTerrainType">#</a>
		<code><a href="source-class-terrain.html#35-57" title="Go to source code">getTerrainType</a>( <span>mixed <var>$coordinates</var></span>, <span>integer <var>$planetID</var></span> )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			
<p>Querys database and looks for terrain type field and returns it.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$coordinates</var></dt>
					<dd><code>mixed</code><br>$coordinates</dd>
					<dt><var>$planetID</var></dt>
					<dd><code>integer</code><br>$planetID</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>integer</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="displayTerrainType" id="_displayTerrainType">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_displayTerrainType">#</a>
		<code><a href="source-class-terrain.html#62-74" title="Go to source code">displayTerrainType</a>( <span>integer <var>$type</var></span>, <span>mixed <var>$image</var> = <span class="php-keyword1">FALSE</span></span> )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$type</var></dt>
					<dd><code>integer</code><br>$type</dd>
					<dt><var>$image</var></dt>
					<dd></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br>Either returns the image or the text type<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="drawMap" id="_drawMap">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_drawMap">#</a>
		<code><a href="source-class-terrain.html#77-105" title="Go to source code">drawMap</a>( <span>integer <var>$planetID</var></span>, <span>integer <var>$planetSize</var></span> )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$planetID</var></dt>
					<dd><code>integer</code><br>$planetID</dd>
					<dt><var>$planetSize</var></dt>
					<dd><code>integer</code><br>$planetSize</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	</table>












	<table class="summary" id="properties">
	<caption>Properties summary</caption>
	<tr data-order="text" id="$text">
		<td class="attributes"><code>
			public  
			array
		</code></td>

		<td class="name">
				<a href="source-class-terrain.html#15-33" title="Go to source code"><var>$text</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span> (
    <span class="php-num">0</span> =&gt; <span class="php-quote">'Grassland'</span>,
    <span class="php-num">1</span> =&gt; <span class="php-quote">'Desert'</span>,
    <span class="php-num">2</span> =&gt; <span class="php-quote">'River'</span>,
    <span class="php-num">3</span> =&gt; <span class="php-quote">'Volcanic'</span>,
    <span class="php-num">4</span> =&gt; <span class="php-quote">'Crater'</span>,
    <span class="php-num">5</span> =&gt; <span class="php-quote">'Glacier'</span>,
    <span class="php-num">6</span> =&gt; <span class="php-quote">'Ocean'</span>,
    <span class="php-num">7</span> =&gt; <span class="php-quote">'Swamp'</span>,
    <span class="php-num">8</span> =&gt; <span class="php-quote">'Cave'</span>,
    <span class="php-num">9</span> =&gt; <span class="php-quote">'Gas Giant'</span>,
    <span class="php-num">10</span> =&gt; <span class="php-quote">'Mountain'</span>,
    <span class="php-num">11</span> =&gt; <span class="php-quote">'Sun'</span>,
    <span class="php-num">12</span> =&gt; <span class="php-quote">'Black Hole'</span>,
    <span class="php-num">13</span> =&gt; <span class="php-quote">'Forest'</span>,
    <span class="php-num">14</span> =&gt; <span class="php-quote">'Jungle'</span>,
    <span class="php-num">15</span> =&gt; <span class="php-quote">'Rock'</span>,
    <span class="php-num">16</span> =&gt; <span class="php-quote">'None'</span>
)</code></td>
		<td class="description"><div>
			<a href="#$text" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	</table>






</div>

	<div id="footer">
		PhpProject1 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</div>
</body>
</html>
